Mark Shipment as Shipped
curl --request POST \
--url https://{base_url_domain}/api/global/v1/shipping/shipments/{id}/shipped \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"primary_tracking_number": "987654321",
"primary_tracking_description": "FedEx Ground",
"alternate_tracking_number": "123456789",
"alternate_tracking_description": "FedEx Alternate",
"manifest_courier_code": "FEDEX"
}
'import requests
url = "https://{base_url_domain}/api/global/v1/shipping/shipments/{id}/shipped"
payload = {
"primary_tracking_number": "987654321",
"primary_tracking_description": "FedEx Ground",
"alternate_tracking_number": "123456789",
"alternate_tracking_description": "FedEx Alternate",
"manifest_courier_code": "FEDEX"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
primary_tracking_number: '987654321',
primary_tracking_description: 'FedEx Ground',
alternate_tracking_number: '123456789',
alternate_tracking_description: 'FedEx Alternate',
manifest_courier_code: 'FEDEX'
})
};
fetch('https://{base_url_domain}/api/global/v1/shipping/shipments/{id}/shipped', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{base_url_domain}/api/global/v1/shipping/shipments/{id}/shipped",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'primary_tracking_number' => '987654321',
'primary_tracking_description' => 'FedEx Ground',
'alternate_tracking_number' => '123456789',
'alternate_tracking_description' => 'FedEx Alternate',
'manifest_courier_code' => 'FEDEX'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{base_url_domain}/api/global/v1/shipping/shipments/{id}/shipped"
payload := strings.NewReader("{\n \"primary_tracking_number\": \"987654321\",\n \"primary_tracking_description\": \"FedEx Ground\",\n \"alternate_tracking_number\": \"123456789\",\n \"alternate_tracking_description\": \"FedEx Alternate\",\n \"manifest_courier_code\": \"FEDEX\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{base_url_domain}/api/global/v1/shipping/shipments/{id}/shipped")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"primary_tracking_number\": \"987654321\",\n \"primary_tracking_description\": \"FedEx Ground\",\n \"alternate_tracking_number\": \"123456789\",\n \"alternate_tracking_description\": \"FedEx Alternate\",\n \"manifest_courier_code\": \"FEDEX\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{base_url_domain}/api/global/v1/shipping/shipments/{id}/shipped")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"primary_tracking_number\": \"987654321\",\n \"primary_tracking_description\": \"FedEx Ground\",\n \"alternate_tracking_number\": \"123456789\",\n \"alternate_tracking_description\": \"FedEx Alternate\",\n \"manifest_courier_code\": \"FEDEX\"\n}"
response = http.request(request)
puts response.read_body{
"errors": [
{
"type": "parameters",
"message": "The supplied parameters are invalid.",
"details": [
{
"key": "hold_until_date",
"message": "The date must be in the future."
}
]
}
]
}{
"errors": [
{
"type": "not_found",
"message": "The server could not find the requested resource."
}
]
}{
"errors": [
{
"type": "unable_to_process",
"message": "The supplied parameters are invalid.",
"details": [
{
"key": "hold_until_date",
"message": "The date must be in the future."
}
]
}
]
}Shipments
Mark Shipment as Shipped
Marks a Shipment in the “packed” status as shipped, specified by its id path parameter.
POST
/
v1
/
shipping
/
shipments
/
{id}
/
shipped
Mark Shipment as Shipped
curl --request POST \
--url https://{base_url_domain}/api/global/v1/shipping/shipments/{id}/shipped \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"primary_tracking_number": "987654321",
"primary_tracking_description": "FedEx Ground",
"alternate_tracking_number": "123456789",
"alternate_tracking_description": "FedEx Alternate",
"manifest_courier_code": "FEDEX"
}
'import requests
url = "https://{base_url_domain}/api/global/v1/shipping/shipments/{id}/shipped"
payload = {
"primary_tracking_number": "987654321",
"primary_tracking_description": "FedEx Ground",
"alternate_tracking_number": "123456789",
"alternate_tracking_description": "FedEx Alternate",
"manifest_courier_code": "FEDEX"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
primary_tracking_number: '987654321',
primary_tracking_description: 'FedEx Ground',
alternate_tracking_number: '123456789',
alternate_tracking_description: 'FedEx Alternate',
manifest_courier_code: 'FEDEX'
})
};
fetch('https://{base_url_domain}/api/global/v1/shipping/shipments/{id}/shipped', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{base_url_domain}/api/global/v1/shipping/shipments/{id}/shipped",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'primary_tracking_number' => '987654321',
'primary_tracking_description' => 'FedEx Ground',
'alternate_tracking_number' => '123456789',
'alternate_tracking_description' => 'FedEx Alternate',
'manifest_courier_code' => 'FEDEX'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{base_url_domain}/api/global/v1/shipping/shipments/{id}/shipped"
payload := strings.NewReader("{\n \"primary_tracking_number\": \"987654321\",\n \"primary_tracking_description\": \"FedEx Ground\",\n \"alternate_tracking_number\": \"123456789\",\n \"alternate_tracking_description\": \"FedEx Alternate\",\n \"manifest_courier_code\": \"FEDEX\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{base_url_domain}/api/global/v1/shipping/shipments/{id}/shipped")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"primary_tracking_number\": \"987654321\",\n \"primary_tracking_description\": \"FedEx Ground\",\n \"alternate_tracking_number\": \"123456789\",\n \"alternate_tracking_description\": \"FedEx Alternate\",\n \"manifest_courier_code\": \"FEDEX\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{base_url_domain}/api/global/v1/shipping/shipments/{id}/shipped")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"primary_tracking_number\": \"987654321\",\n \"primary_tracking_description\": \"FedEx Ground\",\n \"alternate_tracking_number\": \"123456789\",\n \"alternate_tracking_description\": \"FedEx Alternate\",\n \"manifest_courier_code\": \"FEDEX\"\n}"
response = http.request(request)
puts response.read_body{
"errors": [
{
"type": "parameters",
"message": "The supplied parameters are invalid.",
"details": [
{
"key": "hold_until_date",
"message": "The date must be in the future."
}
]
}
]
}{
"errors": [
{
"type": "not_found",
"message": "The server could not find the requested resource."
}
]
}{
"errors": [
{
"type": "unable_to_process",
"message": "The supplied parameters are invalid.",
"details": [
{
"key": "hold_until_date",
"message": "The date must be in the future."
}
]
}
]
}Authorizations
Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.
Path Parameters
The id of the referenced Shipment.
Required range:
x >= 1Body
application/json
Primary tracking number for the shipment.
Example:
"987654321"
Description of the primary tracking number.
Example:
"FedEx Ground"
Alternate tracking number for the shipment.
Example:
"123456789"
Description of the alternate tracking number.
Example:
"FedEx Alternate"
Courier code for the manifest.
Example:
"FEDEX"
Response
OK - The operation completed successfully and there is no response body.
Was this page helpful?
⌘I